Streams related Class

Parameters:

• [options] Object optional

  options for the tool

  • [publisherId] String optional

    Either this or "stream" is required. Publisher id of the stream to which the others are related

  • [streamName] String optional

    Either this or "stream" is required. Name of the stream to which the others are related

  • [tag="div"] String optional

    The type of element to contain the preview tool for each related stream.

  • [stream] Q.Streams.Stream optional

    You can pass a Streams.Stream object here instead of "publisherId" and "streamName"

  • relationType=null String

    The type of the relation.

  • [isCategory=true] Boolean optional

    Whether to show the streams related TO this stream, or the ones it is related to.

  • [relatedOptions] Object optional

    Can include options like 'limit', 'offset', 'ascending', 'min', 'max', 'prefix' and 'fields'

  • [editable] Boolean optional

    Set to false to avoid showing even authorized users an interface to replace the image or text of related streams

  • [closeable] Boolean optional

    Set to false to avoid showing even authorized users an interface to close related streams

  • [creatable] Object optional

    Optional pairs of {streamType: toolOptions} to render Streams/preview tools create new related streams. The params typically include at least a "title" field which you can fill with values such as "New" or "New ..."

  • [toolName] Function optional

    Function that takes (streamType, options) and returns the name of the tool to render (and then activate) for that stream. That tool should reqire the "Streams/preview" tool, and work with it as documented in "Streams/preview".

  • [realtime=false] Boolean optional

    Whether to refresh every time a relation is added, removed or updated by anyone

  • [sortable] Object optional

    Options for "Q/sortable" jQuery plugin. Pass false here to disable sorting interface. If streamName is not a String, this interface is not shown.

  • [tabs] Function optional

    Function for interacting with any parent "Q/tabs" tool. Format is function (previewTool, tabsTool) { return urlOrTabKey; }

  • [updateOptions] Object optional

    Options for onUpdate such as duration of the animation, etc.

  • [onUpdate] Q.Event optional

    Event that receives parameters "data", "entering", "exiting", "updating"

  • [onRefresh] Q.Event optional

    Event that occurs when the tool is completely refreshed, the "this" is the tool